home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Xm / XmClipboardInquireFormat.z / XmClipboardInquireFormat
Encoding:
Text File  |  2002-10-03  |  5.7 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeFFFFoooorrrrmmmmaaaatttt((((3333XXXXUUUU))))NNNNIIIIXXXX SSSSyyyysssstttteeeemmmmXXXXVVVVmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeFFFFoooorrrrmmmmaaaatttt((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeFFFFoooorrrrmmmmaaaatttt - A clipboard function that returns
  10.           a specified format name
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/CutPaste.h>
  14.           int XmClipboardInquireFormat (_d_i_s_p_l_a_y, _w_i_n_d_o_w, _i_n_d_e_x, _f_o_r_m_a_t__n_a_m_e__b_u_f,
  15.                   _b_u_f_f_e_r__l_e_n, _c_o_p_i_e_d__l_e_n)
  16.                   Display * _d_i_s_p_l_a_y;
  17.                   Window  _w_i_n_d_o_w;
  18.                   int     _i_n_d_e_x;
  19.                   XtPointer       _f_o_r_m_a_t__n_a_m_e__b_u_f;
  20.                   unsigned long   _b_u_f_f_e_r__l_e_n;
  21.                   unsigned long   * _c_o_p_i_e_d__l_e_n;
  22.           (vvvvooooiiiidddd)
  23.  
  24.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  25.           This page documents Motif 2.1.
  26.  
  27.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  28.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeFFFFoooorrrrmmmmaaaatttt returns a specified format name for
  29.           the data item in the clipboard. If the name must be
  30.           truncated, the function returns a warning status.
  31.  
  32.           _d_i_s_p_l_a_y   Specifies a pointer to the DDDDiiiissssppppllllaaaayyyy structure that
  33.                     was returned in a previous call to XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy or
  34.                     XXXXttttDDDDiiiissssppppllllaaaayyyy.
  35.  
  36.           _w_i_n_d_o_w    Specifies the window ID of a widget that relates
  37.                     the application window to the clipboard. The
  38.                     widget's window ID can be obtained through
  39.                     XXXXttttWWWWiiiinnnnddddoooowwww.  The same application instance should
  40.                     pass the same window ID to each of the clipboard
  41.                     functions that it calls.
  42.  
  43.           _i_n_d_e_x     Specifies which of the ordered format names to
  44.                     obtain. If this index is greater than the number
  45.                     of formats for the data item, this function
  46.                     returns a 0 (zero) in the _c_o_p_i_e_d__l_e_n argument.
  47.  
  48.           _f_o_r_m_a_t__n_a_m_e__b_u_f
  49.                     Specifies the buffer that receives the format
  50.                     name.
  51.  
  52.           _b_u_f_f_e_r__l_e_n
  53.                     Specifies the number of bytes in the format name
  54.                     buffer.
  55.  
  56.           _c_o_p_i_e_d__l_e_n
  57.                     Specifies the number of bytes in the data item
  58.                     copied to the buffer.  If this argument equals 0
  59.                     (zero), there is no _nth format for the data item.
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeFFFFoooorrrrmmmmaaaatttt((((3333XXXXUUUU))))NNNNIIIIXXXX SSSSyyyysssstttteeeemmmmXXXXVVVVmmmmCCCClllliiiippppbbbbooooaaaarrrrddddIIIInnnnqqqquuuuiiiirrrreeeeFFFFoooorrrrmmmmaaaatttt((((3333XXXX))))
  71.  
  72.  
  73.  
  74.      RRRREEEETTTTUUUURRRRNNNN
  75.           _X_m_C_l_i_p_b_o_a_r_d_S_u_c_c_e_s_s
  76.                     The function was successful.
  77.  
  78.           _X_m_C_l_i_p_b_o_a_r_d_L_o_c_k_e_d
  79.                     The function failed because the clipboard was
  80.                     locked by another application. The application can
  81.                     continue to call the function again with the same
  82.                     parameters until the lock goes away. This gives
  83.                     the application the opportunity to ask if the user
  84.                     wants to keep trying or to give up on the
  85.                     operation.
  86.  
  87.           _X_m_C_l_i_p_b_o_a_r_d_T_r_u_n_c_a_t_e
  88.                     The data returned is truncated because the user
  89.                     did not provide a buffer large enough to hold the
  90.                     data.
  91.  
  92.           _X_m_C_l_i_p_b_o_a_r_d_N_o_D_a_t_a
  93.                     The function could not find data on the clipboard
  94.                     corresponding to the format requested.  This could
  95.                     occur because the clipboard is empty; there is
  96.                     data on the clipboard, but not in the requested
  97.                     format; or the data in the requested format was
  98.                     passed by name and is no longer available.
  99.  
  100.      RRRREEEELLLLAAAATTTTEEEEDDDD
  101.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy(3).
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.